Worklist/Items({SerialNumber})
Returns a worklist item for the matching the SerialNumber.
URI
{Service Root URI}/Worklist/Items({SerialNumber})?{Query Options}
https://api.denallix.com:443/K2Services/REST.svc/Worklist/Items(19_10)?piDataField=true&actDataField=true
Method
GET
Service Path Options
Required
- SerialNumber (String) – the serial number for the worklist item
Query Options
No filters are applied if options are not provided.
Optional
- System Query Options
- Custom Query Options – by default task detail data will not be returned. Changing either the service configuration (web.config) or providing these query options can override whether detail data is returned.
-
- allocate (Boolean) – determines if the worklist item will be allocated to current user on retrieval
- piDataField (Boolean) – determines if process level data fields should be returned
- piXmlField (Boolean) – determines if process level XML fields should be returned
- actDataField (Boolean) – determines if activity level data fields should be returned
- actXmlField (Boolean) – determines if activity level XML fields should be returned
Return Type
WorklistItem or Failure
GET /K2Services/REST.svc/Worklist/Items(19_10) <?xml version="1.0" encoding="utf-8"?> <WorklistItem AllocatedUser="K2:DENALLIX\Bob" ID="25" SerialNumber="19_10" Status="Open" xmlns="http://schemas.k2.com/worklist/d1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Data>http://DLX:81/Workspace/ClientEventPages/K2_Examples/Order_Process_Page_9103682c.aspx?SN=19_10</Data> <Action Name="Approve" Batchable="true"/> <Action Name="Decline" Batchable="true"/> <Action Name="Rework" Batchable="true"/> <ProcessInstance ExpectedDuration="0" Folder="K2 Examples" Folio="Order Process - K2" FullName="K2 Examples\Order Process" Guid="7e8f9361-148e-44ec-8ed0-23f9d52ddfde" ID="19" Name="Order Process" Priority="1" StartDate="2011-02-16T20:26:29.343Z" Status="Active" xmlns="http://schemas.k2.com/process/d1"> <Description/> <Metadata>Blank</Metadata> </ProcessInstance> <ActivityInstanceDestination ActID="9" ActInstID="7" ExpectedDuration="0" ID="10" Name="Manager Approval" Priority="1" ProcInstID="19" StartDate="2011-02-16T20:26:29.43Z" xmlns="http://schemas.k2.com/activity/d1"> <Description/> <Metadata/> </ActivityInstanceDestination> <ActivityInstanceDestination ExpectedDuration="0" ID="14" Name="Order Approval" Priority="1" StartDate="2011-02-16T20:26:29.487Z" xmlns="http://schemas.k2.com/event/d1"> <Description/> <Metadata/> </ActivityInstanceDestination> </WorklistItem>